home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / dev / misc / hwgrcs.lha / HWGRCS / README.first
Encoding:
Text File  |  1993-02-21  |  10.0 KB  |  259 lines
  1.  
  2. README V1.0 21.jan.93 HWG
  3.        V1.1 20.feb.93 HWG Patch level 2
  4.  
  5.  
  6. Ok, you are probably familiar with the RCS distributed on Fish 281/282 and
  7. Fish 451. It's some 4.x version which I will refer to as "Fish RCS". The
  8. current version is (to my knowledge) 5.6.
  9.  
  10. This archive contains a complete port of RCS 5.6, GNU DIFF 1.15 and my LP
  11. utility to support paged diff outputs. This file contains _all_ the Amiga
  12. specific information. READ IT!
  13.  
  14.  
  15. First of all:
  16.  
  17.     - The version of this readme file states the patch level HWGRCS is
  18.       currently at. DO NOT APPLY PATCHES LESS OR EQUAL TO THIS LEVEL! They
  19.       are already included! Patchfiles are called "hwgrcsp<x>.lha" where
  20.       <x> is the patch number.
  21.  
  22.     - Thanks to Hans-Joachim Widmaier (jbhr@sofal.adsp.sub.org) who
  23.       supplied me with the sources to RCS 5.6 and GNU DIFF 1.15. He
  24.       prepared the complete docs including the AmigaGuide® file, too.
  25.  
  26.     - Though the names of all the executables are unchanged, I called this
  27.       distribution HWGRCS instead of just RCS. I hope to avoid confusion
  28.       about what people refer to this way. So if you or anybody refers to
  29.       _this_ stuff, please call it HWGRCS. This way I get the blame and
  30.       glory for what I did and maybe a chance to hear about bugs. :-)
  31.  
  32.     - The archive contains GNUDIFF 1.15 in HWGDIFF and RCS 5.6 in HWGRCS.
  33.       The binaries are in the BIN directory. Please leave them there and
  34.       read "Installation" below.
  35.  
  36.     - DISCLAIMER: I HOPE THIS STUFF HELPS YOU AS IT DOES ME. IF IT
  37.       TRASHES YOUR SOURCES OR DOES ANY OTHER DAMAGE TO YOU OR YOUR COMPUTER
  38.       I WON'T BE HELD RESPONSIBLE FOR IT IN ANY CASE!
  39.  
  40.       Please read the GNU file "COPYING". Especially the NO WARRANTY stuff
  41.       (11. and 12. I think).
  42.  
  43.       I intend to support this release as I use and need HWGRCS myself.
  44.       Please note that I don't want to charge anybody any fee for
  45.       supporting HWGRCS. But if you think this is absolutely great SW, I
  46.       don't mind if you send me something nice and useful for supporting
  47.       it, even though it isn't actually giftware or shareware. If you
  48.       make commercial use of HWGRCS I apply to your conscience with this.
  49.       I'm trying to be a starving greedy artist ... ;^) BTW, jbhr really
  50.       always helped me out in a matter of hours ... :-)
  51.  
  52.     - If this readme is dated 21.jan.93 you get the first public release of
  53.       HWGRCS. So be extra careful.
  54.  
  55.     - I did minor modifications to the source in various places for
  56.       compatibility with SAS/C 6.1. The makefiles were changed, too.
  57.       This changes were rather carefully done (I hope). All of HWGRCS
  58.       including the diff stuff compiles nicely under SAS/C 6.1. The
  59.       original makefiles are named "makefile" and the new SAS/C 6.1
  60.       makefiles "smakefile".
  61.       Note that SAS/C <=6.2 is missing a few "const" keywords in its
  62.       standard headers. You need to add them according to the SAS/C
  63.       documentation to avoid compiler errors.
  64.  
  65.     - HWGRCS 5.6 depends on >=V37 being around. I use it only with >=V39.
  66.  
  67.     - You won't find any Amiga specific notes in the original readmes. I
  68.       left as much unchanged as I could.
  69.  
  70.     - Bugs most likely have to do with me porting HWGRCS, so the bug report
  71.       address mentioned in the original docs won't be of much use to you.
  72.  
  73.  
  74. Limitations:
  75.  
  76.     - HWGRCS doesn't support AmigaDOS links yet. I might add this. Don't
  77.       know yet. Have to do some research about what u*ix does ...
  78.  
  79.     - No user and group id stuff for networking yet. I'll try to add this
  80.       if possible once it is clear to me how all this stuff really hangs
  81.       together.
  82.  
  83.  
  84. Enhancements:
  85.  
  86.     - The original RCS looks into the "RCS/" directory for RCS files and
  87.       checks the current directory, too. I added the "RCS_link" feature of
  88.       "Fish RCS" to HWGRCS. Now HWGRCS looks for the directory name to use
  89.       in this order:
  90.  
  91.             1.) Use the first line of the file "RCS_link" in the working
  92.                 directory if it exists. A slash is added if necessary.
  93.  
  94.             2.) Check ENV:RCS/DIRECTORY for the name. A slash is added if
  95.                 necessary.
  96.  
  97.             3.) Use "RCS/" as name.
  98.  
  99.       The first one found will be used. There is no recheck for the other
  100.       alternatives as this would require major changes to the source.
  101.       I currently don't intend to implement that as it might break a lot
  102.       that I don't see.
  103.  
  104.     - Everything should be residentable.
  105.  
  106.     - You'll find an AmigaDOS implementation of rcsfreeze, too.
  107.       There is one change though which I find useful. If you have a default
  108.       branch set for a file, this branch number is used to freeze the
  109.       revision instead of the head value. Just look at the script.
  110.  
  111.     - I put in a quick hack: You'll find a modified SAS/C 6.1 _main.c in
  112.       the HWGRCS source. This _main.c does filename expansion via the V37
  113.       pattern matching functions for any argument that
  114.  
  115.         - starts with a letter, digit, underscore, colon, slash or
  116.           on of '#', '?', '*', '(', '~'
  117.         - and contains at least one of '#', '?', '*'
  118.  
  119.       As you see it won't expand unix style options. I needed this as the
  120.       shell doesn't support command lines of arbitrary length and the
  121.       standard SAS/C startup doesn't support more than 32 arguments.
  122.       My _main.c should be able to handle _lots_ of arguments. So you might
  123.       end up with a really large argc value ;-)
  124.  
  125.       Now you can do a "ci (#?.c|#?.h)" just by typing it :-)
  126.  
  127.       I say this is a hack for several reasons:
  128.  
  129.         1. Anything that fulfills the criteria mentioned above is
  130.            considered a filename. No matter what it really is.
  131.         2. I put this together _quick_ without doing major testing.
  132.         3. This filename expansion is done on startup. Things like RCS_link
  133.            won't be checked.
  134.  
  135.     - You'll find a tiny script there, too: setuprcs
  136.       This script sets up an RCS directory and the appropriate RCS_link
  137.       file for you in the current directory. I suggest you use it. Makes
  138.       life a lot easier.
  139.  
  140.     - If you hit CTRL-C the original RCS left you with a partially written
  141.       lockfile. I put in a fix that makes this temporary file removeable
  142.       for HWGRCS. I don't think this will break anything.
  143.  
  144.     - HWGRCS supports comment leaders for .a, .asm, .i, and .fd files. The
  145.       comment leader for these files is "* ".
  146.  
  147. Bugs fixed:
  148.  
  149.     - The first release of HWGRCS had two bugs:
  150.  
  151.         - DIFF had problems with the AmigaDOS filepath format
  152.  
  153.         - "-M" did not work with the appropriate rcs commands because of a
  154.           library bug in SAS/C.
  155.  
  156.  
  157. Special Notes:
  158.  
  159.     - There is an environment variable RCSINIT mentioned in the manuals.
  160.       With HWGRCS this is actually RCS/INIT to keep everything pertaining
  161.       to HWGRCS in one place.
  162.  
  163.     - I used a PIPE: based popen implementation for diff3 written by Rick
  164.       Schaeffer modified in a few places for SAS/C 6.1 compatibility.
  165.       Thanks to Georg Sassen for emailing me the source for it.
  166.  
  167.     - HWGRCS won't work if your timezone isn't set. So you definitely NEED
  168.       TO SET THE TZ ENVIRONMENT VARIABLE CORRECTLY!
  169.  
  170.         The SAS/C TZ format is
  171.  
  172.             "aaabbbccc"
  173.  
  174.             aaa     the name of your timezone like CST or MET.
  175.                     HWGRCS supportds a huge amount of names. You shouldn't
  176.                     have a problem finding one that fits you needs.
  177.                     Just set TZ, checkk in some dummy file and look the
  178.                     date with the rlog command to see if it works.
  179.  
  180.             bbb     the offset in hours to GMT.
  181.  
  182.             ccc     If this is present the internal SAS/C variable
  183.                     __daylight will be set. As HWGRCS accepts timezone
  184.                     names referring to daylight savings time, I suggest you
  185.                     don't use this field. It's not tested.
  186.  
  187.       On my machine I use currently "MET0" for ENV:TZ
  188.  
  189.       TZ is not stored in  ENV:RCS as it should be of "global" use to you.
  190.  
  191.     - As GNUDIFF 1.15 works with the ISO character set instead of ASCII,
  192.       you won't have problems with e.g. german umlauts or the copyright
  193.       sign as you had with "Fish RCS".
  194.  
  195.     - I put version strings in the executables. So please report the output
  196.       of the VERSION FULL command with any bugs.
  197.  
  198.     - I partially ported the "rcstest" script to the amiga. It is in the
  199.       source as "rcstestamiga". If anybody completes it by just using
  200.       standard shell commands, I wouldn't mind recieving a copy.
  201.  
  202.     - If anybody gets this to Fred Fish before I do, and mentions
  203.       Hans-Joachim Widmaier and me correctly in the contents entry, I
  204.       wouldn't mind either.
  205.  
  206.     - diff can produce paged output by calling PR. I changed this to call
  207.       my LP utility. You might want to do a "LP ?" to check it out. It is
  208.       an AmigaOS style program which supports the current printer
  209.       preferences and prints to PRT: if you don't say otherwise. Just use
  210.       e.g. OUTPUT=TST and play with it. You might like it.
  211.       I did LP because that's about the only small tool I missed on the
  212.       Amiga. Something like the old N*rton LinePrint.
  213.  
  214.     - The AmigaGuide file works with V39. Don't know about anything else.
  215.  
  216.  
  217. Installation:
  218.  
  219.     - Put the archive stuff anywhere you want it. The relevant executables
  220.       are in BIN.
  221.  
  222.     - Add an "Assign RCS: <anywhere/BIN>" and a "Path RCS:" to your
  223.       S:User-Startup
  224.       YOu might want to add the path statement before e.g. your compiler
  225.       path. GNU diff is _very_ powerful.
  226.  
  227.     - You might need to raise your stack value. I haven't checked this. I
  228.       always use 32K for any shell and I'm fine.
  229.  
  230.     - Set up your timezone with e.g. "SetEnv TZ MET0" or "SetEnv TZ CST6".
  231.       Please read "Special Notes" above!
  232.  
  233.     - Don't forget to copy ENV:TZ to ENVARC:TZ!
  234.  
  235.     - Before using it, read at least some of the docs in HWGRCS/MAN!
  236.  
  237.  
  238. Please report bugs, enhancement request etc. concerning HWGRCS to me:
  239.  
  240.     Heinz Wrobel
  241.     Karlstr. 16
  242.     8035 Gauting
  243.     Germany
  244.  
  245.     FAX + 49 89 850 51 25
  246.  
  247.     heinz@edohwg.adsp.sub.org
  248.  
  249.     cbmehq!cbmger!edohwg!heinz@cbmvax.commodore.com
  250.  
  251.  
  252. Please note that I'm not related to C=!
  253.  
  254. Well, have fun with it.
  255.  
  256.  
  257. Heinz Wrobel
  258.  
  259.